User Credentials

Modules
	Credential fields length

Functions
NQ_BOOL	ccResetCredentailsA (const NQ_CHAR *mountpoint)
NQ_BOOL	ccResetCredentails (const NQ_WCHAR *mountpoint)
NQ_BOOL	ccValidateUserA (NQ_CHAR *server)
NQ_BOOL	ccValidateUser (NQ_WCHAR *server)
NQ_BOOL	ccValidateUserByCredentialsA (NQ_CHAR *server, const AMCredentialsA *userCredentials)
NQ_BOOL	ccValidateUserByCredentials (NQ_WCHAR *server, const AMCredentials *userCredentials)

Detailed Description

Function Documentation

NQ_BOOL ccResetCredentailsA

(

const NQ_CHAR *

mountpoint

)

This function clears user credentials associated with the given mount point.

After this call, NQ will query application in any of the following cases:

• Reconnecting one of the shares, associated with this mount point as a result of a temporary server disconnect.
• Establishing a connection with additional servers as a result of DFS redirection.

This call does not affect those shares that were connected before this call.

Parameters

mountpoint

The name of the mount point to clear credentials.

Returns

TRUE on success, FALSE on failure.

Note

This is an ASCII version of ccResetCredentails()

NQ_BOOL ccResetCredentails

(

const NQ_WCHAR *

mountpoint

)

This function clears user credentials associated with the given mount point.

After this call, NQ will query application in any of the following cases:

• Reconnecting one of the shares, associated with this mount point as a result of a temporary server disconnect.
• Establishing a connection with additional servers as a result of DFS redirection. This call does not affect those shares that were connected before this call.

Parameters

mountpoint

The name of the mount point to clear credentials.

Returns

TRUE on success, FALSE on failure.

NQ_BOOL ccValidateUserA

(

NQ_CHAR *

server

)

This function is called by application to verify that the user credentials supplied by udGetCredentials() are sufficient on the specified server. Those credentials can be set by udSetCredentials() before calling this function.

Parameters

server

Server name the credentials should be verified against. If this parameter is NULL then NQ Client will try to automatically discover the Domain Controller and verify the credentials against it.

Returns

This function returns TRUE if the user is successfully authenticated or FALSE otherwise. The application can inspect the error code for the failure reason.

Note

This is an ASCII version of ccValidateUser()

NQ_BOOL ccValidateUser

(

NQ_WCHAR *

server

)

This function is called by application to verify that the user credentials supplied by udGetCredentials() are sufficient on the specified server. Those credentials can be set by udSetCredentials() before calling this function.

Parameters

server

Server name the credentials should be verified against. If this parameter is NULL then NQ Client will try to automatically discover the Domain Controller and verify the credentials against it.

Returns

This function returns TRUE if the user is successfully authenticated or FALSE otherwise. The application can inspect the error code for the failure reason

NQ_BOOL ccValidateUserByCredentialsA	(	NQ_CHAR *	server,
		const AMCredentialsA *	userCredentials
	)

This function is called by application to verify that the supplied user credentials sufficient on the specified server.

Parameters

server	Server name the credentials should be verified against. If this parameter is NULL then NQ Client will try to automatically discover the Domain Controller and verify the credentials against it.
userCredentials	Pointer to a structure, which stores the user credentials. See AMCredentialsA structure. If NULL is supplied the credentials will be queried by udGetCredentials(). To initialize that structure use amCredentialsInitA(). It is the caller responsibility to release that structure.

Returns

This function returns TRUE if the user is successfully authenticated or FALSE otherwise. The application can inspect the error code for the failure reason.

Note

This is an ASCII version of ccValidateUserByCredentials()

NQ_BOOL ccValidateUserByCredentials	(	NQ_WCHAR *	server,
		const AMCredentials *	userCredentials
	)

This function is called by application to verify that the supplied user credentials sufficient on the specified server.

Parameters

server	Server name the credentials should be verified against. If this parameter is NULL then NQ Client will try to automatically discover the Domain Controller and verify the credentials against it.
userCredentials	Pointer to a structure, which stores the user credentials. See AMCredentials structure. If NULL is supplied the credentials will be queried by udGetCredentials(). To initialize that structure use amCredentialsInitW(). It is the caller responsibility to release that structure.

Returns

This function returns TRUE if the user is successfully authenticated or FALSE otherwise. The application can inspect the error code for the failure reason